ShowLinkSourceInfo

Inside Macintosh: OpenDoc Class Reference /: Part 1 - Classes and Methods / ODLinkSource

ShowLinkSourceInfo
Mac OS
The ShowLinkSourceInfo method displays the Link Source Info dialog box for this link-source object.
ODBoolean ShowLinkSourceInfo (
                        in ODFacet facet,
                        in ODUpdateID change, 
                        in ODBoolean changesAllowed,
                        out ODLinkInfoResult infoResult);
facet
A reference to the facet displaying the selected link source.
change
The update ID of the source part's source content.
changesAllowed
kODTrue if the user may change characteristics of this link-source object, otherwise kODFalse.
infoResult
A structure reflecting the user's selections in the Link Source Info dialog box.
return value
kODTrue if the user did not cancel the Link Source Info dialog box, otherwise kODFalse.

DISCUSSION
You call this method in your part's HandleEvent method when the user selects the Link Info item from the Edit menu and the current selection is the border of a link source.
If the change parameter is different from this link-source object's current update ID (as returned by the GetUpdateID method), this link-source object does not have the most recent source content. This situation should occur only if the update mode is manual. In that case, the Update Now button is enabled to allow the user to request the link source to be updated from the source part.
Part viewers (as opposed to part editors) should pass false for the changesAllowed parameter. Changes are disabled automatically if the draft is read only.
The Link Source Info dialog box displays the part kind of the linked data, together with the dates and times of its creation and last update. The dialog box lets the user set the link update mode to automatic (On Save) or manual. The user can also break the link or request an immediate update from the source part to this link-source object.
If the user exits the Link Source Info dialog box by clicking a button other than Cancel, this method returns true and you should examine the action field of the infoResult output parameter to determine what action to take in response to the user's selections.

If the action field is kODLinkInfoBreakLink, your part should relinquish ownership of this link-source object. This operation should be undoable.
If the action field is kODLinkInfoUpdateNow, you should update this link-source object from your part's content and call the ContentUpdated method. This action should not be undoable in view of the part's difficulty in restoring the previous link content.
If the action field is kODLinkInfoOk, you should examine the autoUpdate field of the infoResult output parameter. If the autoUpdate field indicates a change to the update mode for this link-source object (as obtained by calling the IsAutoUpdate method), you should call the SetAutoUpdate method to change the update mode. This operation should not be undoable.

If the user cancels the Link Source Info dialog box, this method returns false and you do not need to take any further action.

EXCEPTIONS

kODErrBrokenLink
Internal error; this link-source object disconnected from its destinations.
kODErrNullFacetInput
The facet parameter is null.
kODErrNullLinkInfoResultInput
The infoResult parameter is null.

SEE ALSO
The ODLinkInfoAction type (page 923).
The ODLinkInfoResult type (page 924).
The ODUpdateID type (page 917).
The ODLink::ShowLinkDestinationInfo method (page 357).
The ODLinkSource::ContentUpdated method (page 378).
The ODLinkSource::GetUpdateID method (page 381).
The ODLinkSource::IsAutoUpdate method (page 381).
The ODLinkSource::SetAutoUpdate method (page 384).
"Selection Info" on page 252 in OpenDoc Programmer's Guide.